

<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
  <meta charset="utf-8" />
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  
  <title>Installing Ceph on Windows &mdash; Ceph Documentation</title>
  

  
  <link rel="stylesheet" href="../../_static/ceph.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
  <link rel="stylesheet" href="../../_static/css/custom.css" type="text/css" />

  
  
    <link rel="shortcut icon" href="../../_static/favicon.ico"/>
  

  
  

  

  
  <!--[if lt IE 9]>
    <script src="../../_static/js/html5shiv.min.js"></script>
  <![endif]-->
  
    
      <script type="text/javascript" id="documentation_options" data-url_root="../../" src="../../_static/documentation_options.js"></script>
        <script src="../../_static/jquery.js"></script>
        <script src="../../_static/underscore.js"></script>
        <script src="../../_static/doctools.js"></script>
    
    <script type="text/javascript" src="../../_static/js/theme.js"></script>

    
    <link rel="index" title="Index" href="../../genindex/" />
    <link rel="search" title="Search" href="../../search/" /> 
</head>

<body class="wy-body-for-nav">

   
  <header class="top-bar">
    

















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="../../" class="icon icon-home"></a> &raquo;</li>
        
      <li>Installing Ceph on Windows</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
          
            <a href="../../_sources/install/windows-install.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
  </header>
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search"  style="background: #eee" >
          

          
            <a href="../../">
          

          
            
            <img src="../../_static/logo.png" class="logo" alt="Logo"/>
          
          </a>

          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../../search/" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        
        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="../../start/intro/">Ceph 简介</a></li>
<li class="toctree-l1"><a class="reference internal" href="../">安装 Ceph</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephadm/">Cephadm</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rados/">Ceph 存储集群</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cephfs/">Ceph 文件系统</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../rbd/">Ceph 块设备</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../radosgw/">Ceph 对象网关</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mgr/">Ceph 管理器守护进程</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../mgr/dashboard/">Ceph 仪表盘</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../api/">API 文档</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../architecture/">体系结构</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/developer_guide/">开发者指南</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../dev/internals/">Ceph 内幕</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../governance/">项目管理</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../foundation/">Ceph 基金会</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ceph-volume/">ceph-volume</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/general/">Ceph 版本（总目录）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../releases/">Ceph 版本（索引）</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../security/">Security</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../glossary/">Ceph 术语</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../jaegertracing/">Tracing</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../translation_cn/">中文版翻译资源</a></li>
</ul>

            
          
        </div>
        
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../../">Ceph</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
<div id="dev-warning" class="admonition note">
  <p class="first admonition-title">Notice</p>
  <p class="last">This document is for a development version of Ceph.</p>
</div>
  <div id="docubetter" align="right" style="padding: 5px; font-weight: bold;">
    <a href="https://pad.ceph.com/p/Report_Documentation_Bugs">Report a Documentation Bug</a>
  </div>

  
  <div class="section" id="installing-ceph-on-windows">
<h1>Installing Ceph on Windows<a class="headerlink" href="#installing-ceph-on-windows" title="Permalink to this headline">¶</a></h1>
<p>The Ceph client tools and libraries can be natively used on Windows. This avoids
the need of having additional layers such as iSCSI gateways or SMB shares,
drastically improving the performance.</p>
<div class="section" id="prerequisites">
<h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2>
<div class="section" id="supported-platforms">
<h3>Supported platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this headline">¶</a></h3>
<p>Windows Server 2019 and Windows Server 2016 are supported. Previous Windows
Server versions, including Windows client versions such as Windows 10, might
work but haven’t been tested.</p>
<p>Windows Server 2016 does not provide Unix sockets, in which case some commands
might be unavailable.</p>
</div>
<div class="section" id="secure-boot">
<h3>Secure boot<a class="headerlink" href="#secure-boot" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">WNBD</span></code> driver hasn’t been signed by Microsoft, which means that Secure Boot
must be disabled.</p>
</div>
<div class="section" id="dokany">
<h3>Dokany<a class="headerlink" href="#dokany" title="Permalink to this headline">¶</a></h3>
<p>In order to mount Ceph filesystems, <code class="docutils literal notranslate"><span class="pre">ceph-dokan</span></code> requires Dokany to be
installed. You may fetch the installer as well as the source code from the
Dokany Github repository: <a class="reference external" href="https://github.com/dokan-dev/dokany/releases">https://github.com/dokan-dev/dokany/releases</a></p>
<p>The minimum supported Dokany version is 1.3.1. At the time of the writing,
Dokany 2.0 is in Beta stage and is unsupported.</p>
<p>Unlike <code class="docutils literal notranslate"><span class="pre">WNBD</span></code>, Dokany isn’t included in the Ceph MSI installer.</p>
</div>
</div>
<div class="section" id="msi-installer">
<h2>MSI installer<a class="headerlink" href="#msi-installer" title="Permalink to this headline">¶</a></h2>
<p>Using the MSI installer is the recommended way of installing Ceph on Windows.
It can be downloaded from here: <a class="reference external" href="https://cloudbase.it/ceph-for-windows/">https://cloudbase.it/ceph-for-windows/</a></p>
<p>As mentioned earlier, the Ceph installer does not include Dokany, which has
to be installed separately.</p>
<p>A server reboot is required after uninstalling the driver, otherwise subsequent
install attempts may fail.</p>
<p>The following project allows building the MSI installer:
<a class="reference external" href="https://github.com/cloudbase/ceph-windows-installer">https://github.com/cloudbase/ceph-windows-installer</a>. It can either use prebuilt
Ceph and WNBD binaries or compile them from scratch.</p>
</div>
<div class="section" id="manual-installation">
<h2>Manual installation<a class="headerlink" href="#manual-installation" title="Permalink to this headline">¶</a></h2>
<p>The following document describes the build process and manual installation:
<a class="reference external" href="https://github.com/ceph/ceph/blob/master/README.windows.rst">https://github.com/ceph/ceph/blob/master/README.windows.rst</a></p>
</div>
<div class="section" id="configuration">
<h2>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline">¶</a></h2>
<p>Please check the <a class="reference external" href="../windows-basic-config">Windows configuration sample</a> to get started.</p>
<p>You’ll also need a keyring file. The <a class="reference external" href="../../cephfs/mount-prerequisites">General CephFS Prerequisites</a> page provides a
simple example, showing how a new CephX user can be created and how its secret
key can be retrieved.</p>
<p>For more details on CephX user management, see the <a class="reference external" href="../../cephfs/client-auth">Client Authentication</a>
and <a class="reference internal" href="../../rados/operations/user-management/#user-management"><span class="std std-ref">User Management</span></a>.</p>
</div>
<div class="section" id="further-reading">
<h2>Further reading<a class="headerlink" href="#further-reading" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><p><a class="reference external" href="../../rbd/rbd-windows/">RBD Windows documentation</a></p></li>
<li><p><a class="reference external" href="../../cephfs/ceph-dokan">CephFS Windows documentation</a></p></li>
<li><p><a class="reference external" href="../windows-troubleshooting">Windows troubleshooting</a></p></li>
</ul>
</div>
</div>



           </div>
           
          </div>
          <footer>

  <hr/>

  <div role="contentinfo">
    <p>
        &#169; Copyright 2016, Ceph authors and contributors. Licensed under Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0).

    </p>
  </div> 

</footer>
        </div>
      </div>

    </section>

  </div>
  

  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script>

  
  
    
   

</body>
</html>